P0: first-run path fix, trigger-optimized description, Pages live demo#2
Merged
Conversation
…e CWD The usage snippets said sys.path.insert(0, scripts), which only works when the working directory happens to be the skill root. In a real session the CWD is the user's project, so the first invocation hit an ImportError before self-correcting. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…ction Description now leads with the outcome (offline single-file map), names more of the phrasings users actually type (concept map, visualize the structure of a doc, summarize notes as a navigable tree, clickable outline), and nudges activation even when 'mind map' is not said. The new section doubles as the marketplace's required 'When to Use'. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
docs/index.html is a real build_html output (self-contained, offline) of docs/demo.md, served via Pages from master:/docs. Browser-verified: root + 6 branches render, full toolbar incl. SVG/PNG export. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the skill and repository documentation to (1) fix first-run import/path guidance so examples work when executed from a user project directory, (2) improve the skill’s trigger-focused description and add explicit “When to use this skill” guidance, and (3) add a docs-side demo Markdown source intended for a GitHub Pages live demo workflow.
Changes:
- Update
SKILL.mddescription and add a “When to use this skill” section; revise usage snippets to buildscripts/paths from the skill base directory rather than CWD. - Update
README.mdwith a GitHub Pages live demo link and adjust usage snippets to reference the installed skill directory explicitly. - Add
docs/demo.mdas a demo outline with markmap frontmatter options.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| SKILL.md | Improves trigger guidance and fixes usage snippets to resolve scripts/ reliably from the skill directory. |
| README.md | Adds live demo link and updates example code to import helpers using an explicit skill install path. |
| docs/demo.md | Adds a demo Markdown outline (with markmap frontmatter) for generating/hosting an example mind map. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three P0 items from the product review:
All 41 regression checks pass; skill-creator quick_validate reports 'Skill is valid!'.
🤖 Generated with Claude Code